home *** CD-ROM | disk | FTP | other *** search
/ IRIX 6.2 Development Libraries / SGI IRIX 6.2 Development Libraries.iso / dist / complib.idb / usr / share / catman / p_man / cat3 / complib / cspsvx.z / cspsvx
Text File  |  1996-03-14  |  9KB  |  265 lines
  1.  
  2.  
  3.  
  4. CCCCSSSSPPPPSSSSVVVVXXXX((((3333FFFF))))                                                          CCCCSSSSPPPPSSSSVVVVXXXX((((3333FFFF))))
  5.  
  6.  
  7.  
  8. NNNNAAAAMMMMEEEE
  9.      CSPSVX - use the diagonal pivoting factorization A = U*D*U**T or A =
  10.      L*D*L**T to compute the solution to a complex system of linear equations
  11.      A * X = B, where A is an N-by-N symmetric matrix stored in packed format
  12.      and X and B are N-by-NRHS matrices
  13.  
  14. SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
  15.      SUBROUTINE CSPSVX( FACT, UPLO, N, NRHS, AP, AFP, IPIV, B, LDB, X, LDX,
  16.                         RCOND, FERR, BERR, WORK, RWORK, INFO )
  17.  
  18.          CHARACTER      FACT, UPLO
  19.  
  20.          INTEGER        INFO, LDB, LDX, N, NRHS
  21.  
  22.          REAL           RCOND
  23.  
  24.          INTEGER        IPIV( * )
  25.  
  26.          REAL           BERR( * ), FERR( * ), RWORK( * )
  27.  
  28.          COMPLEX        AFP( * ), AP( * ), B( LDB, * ), WORK( * ), X( LDX, * )
  29.  
  30. PPPPUUUURRRRPPPPOOOOSSSSEEEE
  31.      CSPSVX uses the diagonal pivoting factorization A = U*D*U**T or A =
  32.      L*D*L**T to compute the solution to a complex system of linear equations
  33.      A * X = B, where A is an N-by-N symmetric matrix stored in packed format
  34.      and X and B are N-by-NRHS matrices.
  35.  
  36.      Error bounds on the solution and a condition estimate are also provided.
  37.  
  38.  
  39. DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  40.      The following steps are performed:
  41.  
  42.      1. If FACT = 'N', the diagonal pivoting method is used to factor A as
  43.            A = U * D * U**T,  if UPLO = 'U', or
  44.            A = L * D * L**T,  if UPLO = 'L',
  45.         where U (or L) is a product of permutation and unit upper (lower)
  46.         triangular matrices and D is symmetric and block diagonal with
  47.         1-by-1 and 2-by-2 diagonal blocks.
  48.  
  49.      2. The factored form of A is used to estimate the condition number
  50.         of the matrix A.  If the reciprocal of the condition number is
  51.         less than machine precision, steps 3 and 4 are skipped.
  52.  
  53.      3. The system of equations is solved for X using the factored form
  54.         of A.
  55.  
  56.      4. Iterative refinement is applied to improve the computed solution
  57.         matrix and calculate error bounds and backward error estimates
  58.         for it.
  59.  
  60.  
  61.  
  62.  
  63.                                                                         PPPPaaaaggggeeee 1111
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70. CCCCSSSSPPPPSSSSVVVVXXXX((((3333FFFF))))                                                          CCCCSSSSPPPPSSSSVVVVXXXX((((3333FFFF))))
  71.  
  72.  
  73.  
  74. AAAARRRRGGGGUUUUMMMMEEEENNNNTTTTSSSS
  75.      FACT    (input) CHARACTER*1
  76.              Specifies whether or not the factored form of A has been supplied
  77.              on entry.  = 'F':  On entry, AFP and IPIV contain the factored
  78.              form of A.  AP, AFP and IPIV will not be modified.  = 'N':  The
  79.              matrix A will be copied to AFP and factored.
  80.  
  81.      UPLO    (input) CHARACTER*1
  82.              = 'U':  Upper triangle of A is stored;
  83.              = 'L':  Lower triangle of A is stored.
  84.  
  85.      N       (input) INTEGER
  86.              The number of linear equations, i.e., the order of the matrix A.
  87.              N >= 0.
  88.  
  89.      NRHS    (input) INTEGER
  90.              The number of right hand sides, i.e., the number of columns of
  91.              the matrices B and X.  NRHS >= 0.
  92.  
  93.      AP      (input) COMPLEX array, dimension (N*(N+1)/2)
  94.              The upper or lower triangle of the symmetric matrix A, packed
  95.              columnwise in a linear array.  The j-th column of A is stored in
  96.              the array AP as follows:  if UPLO = 'U', AP(i + (j-1)*j/2) =
  97.              A(i,j) for 1<=i<=j; if UPLO = 'L', AP(i + (j-1)*(2*n-j)/2) =
  98.              A(i,j) for j<=i<=n.  See below for further details.
  99.  
  100.      AFP     (input or output) COMPLEX array, dimension (N*(N+1)/2)
  101.              If FACT = 'F', then AFP is an input argument and on entry
  102.              contains the block diagonal matrix D and the multipliers used to
  103.              obtain the factor U or L from the factorization A = U*D*U**T or A
  104.              = L*D*L**T as computed by CSPTRF, stored as a packed triangular
  105.              matrix in the same storage format as A.
  106.  
  107.              If FACT = 'N', then AFP is an output argument and on exit
  108.              contains the block diagonal matrix D and the multipliers used to
  109.              obtain the factor U or L from the factorization A = U*D*U**T or A
  110.              = L*D*L**T as computed by CSPTRF, stored as a packed triangular
  111.              matrix in the same storage format as A.
  112.  
  113.      IPIV    (input or output) INTEGER array, dimension (N)
  114.              If FACT = 'F', then IPIV is an input argument and on entry
  115.              contains details of the interchanges and the block structure of
  116.              D, as determined by CSPTRF.  If IPIV(k) > 0, then rows and
  117.              columns k and IPIV(k) were interchanged and D(k,k) is a 1-by-1
  118.              diagonal block.  If UPLO = 'U' and IPIV(k) = IPIV(k-1) < 0, then
  119.              rows and columns k-1 and -IPIV(k) were interchanged and D(k-
  120.              1:k,k-1:k) is a 2-by-2 diagonal block.  If UPLO = 'L' and IPIV(k)
  121.              = IPIV(k+1) < 0, then rows and columns k+1 and -IPIV(k) were
  122.              interchanged and D(k:k+1,k:k+1) is a 2-by-2 diagonal block.
  123.  
  124.              If FACT = 'N', then IPIV is an output argument and on exit
  125.              contains details of the interchanges and the block structure of
  126.  
  127.  
  128.  
  129.                                                                         PPPPaaaaggggeeee 2222
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136. CCCCSSSSPPPPSSSSVVVVXXXX((((3333FFFF))))                                                          CCCCSSSSPPPPSSSSVVVVXXXX((((3333FFFF))))
  137.  
  138.  
  139.  
  140.              D, as determined by CSPTRF.
  141.  
  142.      B       (input) COMPLEX array, dimension (LDB,NRHS)
  143.              The N-by-NRHS right hand side matrix B.
  144.  
  145.      LDB     (input) INTEGER
  146.              The leading dimension of the array B.  LDB >= max(1,N).
  147.  
  148.      X       (output) COMPLEX array, dimension (LDX,NRHS)
  149.              If INFO = 0, the N-by-NRHS solution matrix X.
  150.  
  151.      LDX     (input) INTEGER
  152.              The leading dimension of the array X.  LDX >= max(1,N).
  153.  
  154.      RCOND   (output) REAL
  155.              The estimate of the reciprocal condition number of the matrix A.
  156.              If RCOND is less than the machine precision (in particular, if
  157.              RCOND = 0), the matrix is singular to working precision.  This
  158.              condition is indicated by a return code of INFO > 0, and the
  159.              solution and error bounds are not computed.
  160.  
  161.      FERR    (output) REAL array, dimension (NRHS)
  162.              The estimated forward error bound for each solution vector X(j)
  163.              (the j-th column of the solution matrix X).  If XTRUE is the true
  164.              solution corresponding to X(j), FERR(j) is an estimated upper
  165.              bound for the magnitude of the largest element in (X(j) - XTRUE)
  166.              divided by the magnitude of the largest element in X(j).  The
  167.              estimate is as reliable as the estimate for RCOND, and is almost
  168.              always a slight overestimate of the true error.
  169.  
  170.      BERR    (output) REAL array, dimension (NRHS)
  171.              The componentwise relative backward error of each solution vector
  172.              X(j) (i.e., the smallest relative change in any element of A or B
  173.              that makes X(j) an exact solution).
  174.  
  175.      WORK    (workspace) COMPLEX array, dimension (2*N)
  176.  
  177.      RWORK   (workspace) REAL array, dimension (N)
  178.  
  179.      INFO    (output) INTEGER
  180.              = 0: successful exit
  181.              < 0: if INFO = -i, the i-th argument had an illegal value
  182.              > 0 and <= N: if INFO = i, D(i,i) is exactly zero.  The
  183.              factorization has been completed, but the block diagonal matrix D
  184.              is exactly singular, so the solution and error bounds could not
  185.              be computed.  = N+1: the block diagonal matrix D is nonsingular,
  186.              but RCOND is less than machine precision.  The factorization has
  187.              been completed, but the matrix is singular to working precision,
  188.              so the solution and error bounds have not been computed.
  189.  
  190.  
  191.  
  192.  
  193.  
  194.  
  195.                                                                         PPPPaaaaggggeeee 3333
  196.  
  197.  
  198.  
  199.  
  200.  
  201.  
  202. CCCCSSSSPPPPSSSSVVVVXXXX((((3333FFFF))))                                                          CCCCSSSSPPPPSSSSVVVVXXXX((((3333FFFF))))
  203.  
  204.  
  205.  
  206. FFFFUUUURRRRTTTTHHHHEEEERRRR DDDDEEEETTTTAAAAIIIILLLLSSSS
  207.      The packed storage scheme is illustrated by the following example when N
  208.      = 4, UPLO = 'U':
  209.  
  210.      Two-dimensional storage of the symmetric matrix A:
  211.  
  212.         a11 a12 a13 a14
  213.             a22 a23 a24
  214.                 a33 a34     (aij = aji)
  215.                     a44
  216.  
  217.      Packed storage of the upper triangle of A:
  218.  
  219.      AP = [ a11, a12, a22, a13, a23, a33, a14, a24, a34, a44 ]
  220.  
  221.  
  222.  
  223.  
  224.  
  225.  
  226.  
  227.  
  228.  
  229.  
  230.  
  231.  
  232.  
  233.  
  234.  
  235.  
  236.  
  237.  
  238.  
  239.  
  240.  
  241.  
  242.  
  243.  
  244.  
  245.  
  246.  
  247.  
  248.  
  249.  
  250.  
  251.  
  252.  
  253.  
  254.  
  255.  
  256.  
  257.  
  258.  
  259.  
  260.  
  261.                                                                         PPPPaaaaggggeeee 4444
  262.  
  263.  
  264.  
  265.